FoxitPDFSDKPython3.AccessibilityChecker Class Reference

Inheritance diagram for FoxitPDFSDKPython3.AccessibilityChecker:

Public Member Functions
def	AccessibilityChecker (pdf_doc)
	Constructor. More...
def	CanCheck ()
	Check whether the current PDF document can be full checked. More...
def	ChangeCheckStateInResultTree (root_data, sub_item_data, new_check_state)
	Change check state in result tree. More...
def	GetTagTreeNodeIDByCheckResultItemID (page_index, item_id)
	Get tag tree node ID by check result item ID. More...
def	IsEmpty ()
	Check whether current object is empty or not. More...
def	RecheckResult (check_options, root_data)
	Recheck by result root. More...
def	RemoveSkippedStateInResultTree (check_options, root_data, sub_item_data)
	Remove skipped state in result tree. More...
def	StartCheck (check_options, report_callback, provider, pause)
	Start check for accessibility. More...
def	UpdateCheckResultReport ()
	Update check result report. More...
def	UpdateCheckState (rule_type, check_state)
	Update check state for a specified rule. More...

Detailed Description

This class represents an accessibility checker for a PDF document: run the full accessibility check, re-check parts of the result tree, change / remove check states and update the check result report. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FoxitPDFSDKPython3.Library.Initialize with a key including "Accessibility" module.

See also

FoxitPDFSDKPython3.Library

Constructor & Destructor Documentation

AccessibilityChecker()

def FoxitPDFSDKPython3.AccessibilityChecker.AccessibilityChecker

(

pdf_doc

)

Constructor.

Constructor, with another checker object.

Parameters

[in]	pdf_doc	A valid PDF document object.
[in]	other	Another checker object.

Member Function Documentation

CanCheck()

def FoxitPDFSDKPython3.AccessibilityChecker.CanCheck

(

)

Check whether the current PDF document can be full checked.

Returns

true means the document can be full checked, while false means not.

ChangeCheckStateInResultTree()

def FoxitPDFSDKPython3.AccessibilityChecker.ChangeCheckStateInResultTree	(		root_data,
			sub_item_data,
			new_check_state
	)

Change check state in result tree.

Parameters

[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data.
[in]	new_check_state	The new check state.

Returns

The updated check result item data.

GetTagTreeNodeIDByCheckResultItemID()

def FoxitPDFSDKPython3.AccessibilityChecker.GetTagTreeNodeIDByCheckResultItemID	(		page_index,
			item_id
	)

Get tag tree node ID by check result item ID.

Parameters

[in]	page_index	The page index.
[in]	item_id	The check result item ID.

Returns

The tag tree node ID.

IsEmpty()

def FoxitPDFSDKPython3.AccessibilityChecker.IsEmpty

(

)

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns

true means current object is empty, while false means not.

RecheckResult()

def FoxitPDFSDKPython3.AccessibilityChecker.RecheckResult	(		check_options,
			root_data
	)

Recheck by result root.

Recheck by sub item.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.

Returns

The updated check result item data.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data of check result tree.

Returns

The updated check result item data.

RemoveSkippedStateInResultTree()

def FoxitPDFSDKPython3.AccessibilityChecker.RemoveSkippedStateInResultTree	(		check_options,
			root_data,
			sub_item_data
	)

Remove skipped state in result tree.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data.

Returns

The updated check result item data.

StartCheck()

def FoxitPDFSDKPython3.AccessibilityChecker.StartCheck	(		check_options,
			report_callback,
			provider,
			pause
	)

Start check for accessibility.

Parameters

[in]	check_options	The check options. Please refer to AccessibilityCheckOptions .
[in]	report_callback	A stream callback object for report output. This can be null.
[in]	provider	An AccessibilityCheckResultsCallback object for check results.
[in]	pause	A pause object. This can be null.

Returns

A progressive object.

UpdateCheckResultReport()

def FoxitPDFSDKPython3.AccessibilityChecker.UpdateCheckResultReport

(

)

Update check result report.

Returns

true means success, while false means not.

UpdateCheckState()

def FoxitPDFSDKPython3.AccessibilityChecker.UpdateCheckState	(		rule_type,
			check_state
	)

Update check state for a specified rule.

Parameters

[in]	rule_type	The check rule type. Please refer to values starting from FoxitPDFSDKPython3.e_RuleTypeDocPermission and this should be one of these values.
[in]	check_state	The check state. Please refer to values starting from FoxitPDFSDKPython3.e_CheckStateNone and this should be one of these values.

Returns

true means success, while false means not.